home *** CD-ROM | disk | FTP | other *** search
/ Gigarom 1 / Gigarom Macintosh Archives (Quantum Leap)(CDRM1080320)(1993).iso / FILES / HYP / H-I / HyperHackers.cpt / Hyper-Hackers Queue 1.0 / card_25417.txt < prev    next >
Text File  |  1989-02-26  |  3KB  |  68 lines
  1. -- card: 25417 from stack: in.0
  2. -- bmap block id: 0
  3. -- flags: 0000
  4. -- background id: 3797
  5. -- name: 
  6.  
  7.  
  8. -- part contents for background part 1
  9. ----- text -----
  10.  
  11. From: stephena@microsoft.UUCP (Stephen Arrants 3/1011)
  12.  
  13. Date: 2 Mar 88 17:39:20 GMT
  14.  
  15. In article <5346@well.UUCP>, mitch@well.UUCP (Mitchell Waite) writes:
  16. >.......... In general
  17. > the software creator (be it Digital Research, Lotus, whoever) do a
  18. >crummy job of documentation.
  19.  
  20. I'd say in *very* general.  Computer documentation has really come a
  21. long way in the past few years.
  22.  
  23. >It is done last and fast.
  24.  
  25. I don't think you understand the process of
  26. documentation from the inside at all.  In all the companies I've worked,
  27. the docs never came "fast and last".  The documentation team at
  28. Microsoft, for example,
  29. is included in product development from the start.  Recommendations and
  30. input
  31. from the doc. team is an important part of the total design.
  32. The documentation can take as long as the product
  33. development.
  34.  
  35. >This leaves a giant hole for
  36. > improvements in the documentation and in some cases the >manufacturer
  37. >never fills the hole [    ]
  38.  
  39. Nope.  What leaves these holes are:
  40. 1.  Changes to the software that can't make it into the documentation
  41. because the books are either finishing the run at the printer or that
  42. the books are in the warehouse waiting for the software to arrive for
  43. shipping.
  44. 2.  Cost of Goods.  If a product sells to a distributor for, say $200,
  45. COG can be 15% - $25.  That's $25 for the package, disks, disk labels,
  46. keyboard templates, collateral materials, registration card, and
  47. documentation.  Let's say that the documentation itself is 10% ($20)
  48. COG.  I don't think that software companies are doing too poor a job.
  49. The manuals MUST be comprehensive.  Third party books rarely are.
  50.  
  51. 3.  Errata sheets and README files.  These are caused by #1 above.
  52. Documentation must ship with the software.  Third party books don't have
  53. to ship with the software.
  54.  
  55. >[......]In fact the quickest write the book BEFORE the product is out.
  56.  
  57. What's wrong with that?  You give the impression that the author has no
  58. idea what s/he's documenting.  A *good* author of a third party book
  59. will work with the development, marketing and documentation teams before
  60. the product ships.  Many, many authors use the company's own
  61. documentation as an important source for their own books.  Must be
  62. something good there for an author to rely on it.
  63.  
  64.  
  65.  
  66. -- part contents for background part 45
  67. ----- text -----
  68. Re: HyperTalk Books, How to Judge?